use sphinx and rst to generate documentsΒΆ

http://raxcloud.blogspot.com/2013/02/documenting-python-code-using-sphinx.html ` http://sphinx-doc.org/markup/desc.html#info-field-lists < http://sphinx-doc.org/markup/desc.html#info-field-lists>`_

only generate documents from rst files, not python files

first install sphinx:

$ pip install sphinx

use this python script to create a sphinx project:

from sphinx import quickstart as qs

d = dict(
    path = '.',
    sep  = True,
    dot  = '_',
    project = 'project_name',
    author = 'author_name',
    version = '',
    release = '',
    suffix = '.rst',
    master = 'index',
    epub = True,
    ext_autodoc = False,
    ext_viewcode = False,
    makefile = True,
    batchfile = True,
    mastertocmaxdepth = 1,
)

qs.generate(d, silent=True, overwrite=False)